/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.carbondata.spark.partition.api;

import java.util.List;

import org.apache.carbondata.scan.model.CarbonQueryPlan;

import org.apache.spark.sql.execution.command.Partitioner;

public interface DataPartitioner {
  /**
   * Initialise the partitioner based on the given columns
   */
  void initialize(String basePath, String[] columns, Partitioner partitioner);

  /**
   * All the partitions built by the Partitioner
   */
  List<Partition> getAllPartitions();

  /**
   * Partition where the tuple should be present. (API used for data loading purpose)
   */
  Partition getPartionForTuple(Object[] tuple, long rowCounter);

  /**
   * Identifies the partitions applicable for the given filter (API used for For query)
   */
  List<Partition> getPartitions(CarbonQueryPlan queryPlan);

  String[] getPartitionedColumns();

  Partitioner getPartitioner();

}

